Vcenter Tagging Associations UpdateResult
Represents the result of an update operation. It contains the success status, list of individual tag result for each operation performed and any error messages related to the processing of the Vcenter Tagging Associations UpdateSpec.
This schema was added in vSphere API 9.1.0.0.
{
"success": false,
"results": [
{
"operation": "string",
"tag": "string",
"tag_category_name_info": {
"tag_name": "string",
"category_name": "string"
}
}
],
"errors": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
]
}Indicates whether all requested changes were successfully applied to the resource object.
Sets to true if all Vcenter Tagging Associations TagSpec.operation in Vcenter Tagging Associations UpdateSpec.tag_spec_list completed without errors. Sets to false if one or more Vcenter Tagging Associations TagSpec.operation in Vcenter Tagging Associations UpdateSpec.tag_spec_list failed. See the Vcenter Tagging Associations UpdateResult.errors for details.
This property was added in vSphere API 9.1.0.0.
Represents a list of results from the Vcenter Tagging Associations UpdateSpec.tag_spec_list that were attached or detached. The property does not specify which operations succeeded or failed, but rather which tags were newly added or removed as part of this call. The property is populated only when Vcenter Tagging Associations UpdateResult.success is set to true.
If Vcenter Tagging Associations UpdateResult.success is true and the property contains all the items from Vcenter Tagging Associations UpdateSpec.tag_spec_list, it means that all the requested attach/detach calls were successful and all the attaches/ detaches were performed as part of this call. For example, Suppose no tags are currently attached to the resource. If the call attempts to attach four tags T1, T2, T3 and T4 then this property will contain T1, T2, T3 and T4 as all of them were newly attached. Similarly, suppose all four tags T1, T2, T3 and T4 are currently not attached and this call attempts to detach T1, T2, T3, T4 then this field will only contain T1, T2, T3, T4.
If Vcenter Tagging Associations UpdateResult.success is true and if the property contains only a subset of items from Vcenter Tagging Associations UpdateSpec.tag_spec_list,it means that all requested tags were correctly attached to/ detached from the object. The property indicates which tags were actually attached/ detached as a result of this call. For example, Suppose tags T1, T2 are already attached to the resource. If this call attempts to attach two new tags, say T3 and T4, then this property will only contain T3 and T4, since they were the ones actually attached as part of this call. Similarly, if T1 and T2 are not attached, and this call attempts to detach T1, T2, T3, T4 then this field will only contain T3 and T4, as they were the ones actually detached during this call.
If Vcenter Tagging Associations UpdateResult.success is false, this property is unset. Any item present in the input Vcenter Tagging Associations UpdateSpec.tag_spec_list but missing from the property means that the tag was already attached or detached. It does not indicate a failure of the operation.
This property was added in vSphere API 9.1.0.0.
If missing or null, no tags were applied during this PATCH /vcenter/tagging/associations call.
List of error messages specifying the tags for which the operation failed, if any errors occurred during update processing. This property is populated only when Vcenter Tagging Associations UpdateResult.success is set to false.
This property was added in vSphere API 9.1.0.0.
If missing or null, the PATCH /vcenter/tagging/associations operation completes successfully and no errors occurred.